docs: fix documentation-code mismatches after multi-runtime removal#465
Merged
docs: fix documentation-code mismatches after multi-runtime removal#465
Conversation
Audit all 50+ markdown files against current source code and fix remaining inaccuracies left after the multi-runtime refactoring. Fixes: - Fix run() API examples to match RunParamsInput signature (deployment.md, sandbox-integration.md) - Fix event type names: errorRun→stopRunByError, abbreviated streaming events→full names - Remove ghost event types from events.md (callInteractiveTool, callDelegate, finishAllToolCalls, proxyAccess) - Add missing event types (finishMcpTools, skipDelegates, proceedToInteractiveTools) - Fix CLI reference: timeout default 60000→300000, remove deleted commands (publish/unpublish/tag/status) - Add missing CLI options (--reasoning-budget, --filter) and deepseek provider - Add missing perstack.toml fields (envPath, providerTools, providerSkills, allowedDomains, lazyInit) - Update packages/react README with useJobStream/useJobStreams hooks - Fix going-to-production.md event JSON examples to use actual event type names - Remove stale "(not Docker)" from benchmarks README Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
When a PR only modifies markdown files (*.md), the changeset check is skipped since documentation changes don't require package version bumps. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
FL4TLiN3
force-pushed
the
docs/improve-documentation-accuracy
branch
from
ce3bfa3 to
529454e
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
run()API examples to matchRunParamsInputsignature in deployment and sandbox-integration docserrorRun→stopRunByError, abbreviated streaming event names→full namescallInteractiveTool,callDelegate,finishAllToolCalls,proxyAccess)finishMcpTools,skipDelegates,proceedToInteractiveTools)60000→300000, removed deleted commands (publish/unpublish/tag/status), added--reasoning-budget/--filter/deepseekperstack.tomlfields (envPath,providerTools,providerSkills,allowedDomains,lazyInit)@perstack/reactREADME withuseJobStream/useJobStreamshooksTest plan
pnpm buildto ensure no build regressions🤖 Generated with Claude Code